package com.che.software.testato.domain.entity.search;

import java.io.Serializable;
import java.util.Date;

/**
 * Class representing a hierarchy search.
 * 
 * @author Clement HELIOU (clement.heliou@che-software.com).
 * @copyright Che Software.
 * @license GNU General Public License.
 * @see Serializable
 * @since July, 2011.
 * 
 *        This file is part of Testato.
 * 
 *        Testato is free software: you can redistribute it and/or modify it
 *        under the terms of the GNU General Public License as published by the
 *        Free Software Foundation, either version 3 of the License, or (at your
 *        option) any later version.
 * 
 *        Testato is distributed in the hope that it will be useful, but WITHOUT
 *        ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *        FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 *        for more details.
 * 
 *        You should have received a copy of the GNU General Public License
 *        along with Testato. If not, see <http://www.gnu.org/licenses/>.
 * 
 *        Testato's logo is a creation of Arrioch
 *        (http://arrioch.deviantart.com/) and it's distributed under the terms
 *        of the Creative Commons License.
 */
public class HierarchySearch implements Serializable {

	/**
	 * Constants.
	 */
	private static final long serialVersionUID = 6497044160818556288L;

	/**
	 * Members.
	 */
	private boolean prioritizedExcluded = false;
	private Date creationDate, lastUpdateDate;
	private int hierarchyId, responsableUserId, versionId;
	private Integer iterationId;

	/**
	 * Default builder.
	 */
	public HierarchySearch() {
	}

	/**
	 * Builder from exclusion information.
	 * 
	 * @param prioritizedExcluded the exclusion information (true to exclude the
	 *        prioritized hierarchies).
	 */
	public HierarchySearch(boolean prioritizedExcluded) {
		super();
		this.prioritizedExcluded = prioritizedExcluded;
	}

	/**
	 * Getter for the private field value creationDate.
	 * 
	 * @return the creationDate field value.
	 */
	public Date getCreationDate() {
		return creationDate;
	}

	/**
	 * Setting a value to the creationDate field.
	 * 
	 * @param creationDate the value to set.
	 */
	public void setCreationDate(Date creationDate) {
		this.creationDate = creationDate;
	}

	/**
	 * Getter for the private field value lastUpdateDate.
	 * 
	 * @return the lastUpdateDate field value.
	 */
	public Date getLastUpdateDate() {
		return lastUpdateDate;
	}

	/**
	 * Setting a value to the lastUpdateDate field.
	 * 
	 * @param lastUpdateDate the value to set.
	 */
	public void setLastUpdateDate(Date lastUpdateDate) {
		this.lastUpdateDate = lastUpdateDate;
	}

	/**
	 * Getter for the private field value hierarchyId.
	 * 
	 * @return the hierarchyId field value.
	 */
	public int getHierarchyId() {
		return hierarchyId;
	}

	/**
	 * Setting a value to the hierarchyId field.
	 * 
	 * @param hierarchyId the value to set.
	 */
	public void setHierarchyId(int hierarchyId) {
		this.hierarchyId = hierarchyId;
	}

	/**
	 * Getter for the private field value responsableUserId.
	 * 
	 * @return the responsableUserId field value.
	 */
	public int getResponsableUserId() {
		return responsableUserId;
	}

	/**
	 * Setting a value to the responsableUserId field.
	 * 
	 * @param responsableUserId the value to set.
	 */
	public void setResponsableUserId(int responsableUserId) {
		this.responsableUserId = responsableUserId;
	}

	/**
	 * Getter for the private field value versionId.
	 * 
	 * @return the versionId field value.
	 */
	public int getVersionId() {
		return versionId;
	}

	/**
	 * Setting a value to the versionId field.
	 * 
	 * @param versionId the value to set.
	 */
	public void setVersionId(int versionId) {
		this.versionId = versionId;
	}

	/**
	 * Getter for the private field value prioritizedExcluded.
	 * 
	 * @return the prioritizedExcluded field value.
	 */
	public boolean isPrioritizedExcluded() {
		return prioritizedExcluded;
	}

	/**
	 * Setting a value to the prioritizedExcluded field.
	 * 
	 * @param prioritizedExcluded the value to set.
	 */
	public void setPrioritizedExcluded(boolean prioritizedExcluded) {
		this.prioritizedExcluded = prioritizedExcluded;
	}

	/**
	 * Getter for the private field value iterationId.
	 * 
	 * @return the iterationId field value.
	 */
	public Integer getIterationId() {
		return iterationId;
	}

	/**
	 * Setting a value to the iterationId field.
	 * 
	 * @param iterationId the value to set.
	 */
	public void setIterationId(Integer iterationId) {
		this.iterationId = iterationId;
	}
}